<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensorbase.db;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.List;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.Set;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.logging.Logger;<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>    import javax.xml.datatype.XMLGregorianCalendar;<a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>    import org.hackystat.sensorbase.resource.projects.ProjectManager;<a name="line.9"></a>
<FONT color="green">010</FONT>    import org.hackystat.sensorbase.resource.projects.jaxb.Project;<a name="line.10"></a>
<FONT color="green">011</FONT>    import org.hackystat.sensorbase.resource.projects.jaxb.ProjectSummary;<a name="line.11"></a>
<FONT color="green">012</FONT>    import org.hackystat.sensorbase.resource.sensordata.SensorDataManager;<a name="line.12"></a>
<FONT color="green">013</FONT>    import org.hackystat.sensorbase.resource.sensordata.jaxb.SensorData;<a name="line.13"></a>
<FONT color="green">014</FONT>    import org.hackystat.sensorbase.resource.sensordatatypes.SdtManager;<a name="line.14"></a>
<FONT color="green">015</FONT>    import org.hackystat.sensorbase.resource.sensordatatypes.jaxb.SensorDataType;<a name="line.15"></a>
<FONT color="green">016</FONT>    import org.hackystat.sensorbase.resource.users.UserManager;<a name="line.16"></a>
<FONT color="green">017</FONT>    import org.hackystat.sensorbase.resource.users.jaxb.User;<a name="line.17"></a>
<FONT color="green">018</FONT>    import org.hackystat.sensorbase.server.Server;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    /**<a name="line.20"></a>
<FONT color="green">021</FONT>     * Provides a specification of the operations that must be implemented by every<a name="line.21"></a>
<FONT color="green">022</FONT>     * SensorBase storage system.  Also provides some 'helper' methods, which return<a name="line.22"></a>
<FONT color="green">023</FONT>     * the Managers for the various resources. <a name="line.23"></a>
<FONT color="green">024</FONT>     * @author Philip Johnson<a name="line.24"></a>
<FONT color="green">025</FONT>     */<a name="line.25"></a>
<FONT color="green">026</FONT>    public abstract class DbImplementation {<a name="line.26"></a>
<FONT color="green">027</FONT>      <a name="line.27"></a>
<FONT color="green">028</FONT>      /**<a name="line.28"></a>
<FONT color="green">029</FONT>       * To be called as part of the startup process for a storage system. This method should:<a name="line.29"></a>
<FONT color="green">030</FONT>       * &lt;ul&gt;<a name="line.30"></a>
<FONT color="green">031</FONT>       * &lt;li&gt; Check to see if this storage system has already been created during a previous session.<a name="line.31"></a>
<FONT color="green">032</FONT>       * &lt;li&gt; If no storage system exists, it should create one and initialize it appropriately.<a name="line.32"></a>
<FONT color="green">033</FONT>       * &lt;/ul&gt;<a name="line.33"></a>
<FONT color="green">034</FONT>       */<a name="line.34"></a>
<FONT color="green">035</FONT>      public abstract void initialize();<a name="line.35"></a>
<FONT color="green">036</FONT>      <a name="line.36"></a>
<FONT color="green">037</FONT>      /**<a name="line.37"></a>
<FONT color="green">038</FONT>       * Returns true if the initialize() method did indeed create a fresh storage system.<a name="line.38"></a>
<FONT color="green">039</FONT>       * This is used by the ResourceManagers to determine if they should read in default data or not.<a name="line.39"></a>
<FONT color="green">040</FONT>       * @return True if the storage system is freshly created.<a name="line.40"></a>
<FONT color="green">041</FONT>       */<a name="line.41"></a>
<FONT color="green">042</FONT>      public abstract boolean isFreshlyCreated();<a name="line.42"></a>
<FONT color="green">043</FONT>      <a name="line.43"></a>
<FONT color="green">044</FONT>      /**<a name="line.44"></a>
<FONT color="green">045</FONT>       * Returns the XML SensorDataIndex for all sensor data in this server.<a name="line.45"></a>
<FONT color="green">046</FONT>       * @return The XML String containing an index to all Sensor Data.<a name="line.46"></a>
<FONT color="green">047</FONT>       */<a name="line.47"></a>
<FONT color="green">048</FONT>      public abstract String getSensorDataIndex();<a name="line.48"></a>
<FONT color="green">049</FONT>      <a name="line.49"></a>
<FONT color="green">050</FONT>      /**<a name="line.50"></a>
<FONT color="green">051</FONT>       * Returns the XML SensorDataIndex for all sensor data for this user. <a name="line.51"></a>
<FONT color="green">052</FONT>       * @param user The User whose sensor data is to be returned. <a name="line.52"></a>
<FONT color="green">053</FONT>       * @return The XML String providing an index of all relevent sensor data resources.<a name="line.53"></a>
<FONT color="green">054</FONT>       */<a name="line.54"></a>
<FONT color="green">055</FONT>      public abstract String getSensorDataIndex(User user);<a name="line.55"></a>
<FONT color="green">056</FONT>      <a name="line.56"></a>
<FONT color="green">057</FONT>      /**<a name="line.57"></a>
<FONT color="green">058</FONT>       * Returns the XML SensorDataIndex for all sensor data for this user and sensor data type.<a name="line.58"></a>
<FONT color="green">059</FONT>       * @param user The User whose sensor data is to be returned. <a name="line.59"></a>
<FONT color="green">060</FONT>       * @param sdtName The sensor data type name.<a name="line.60"></a>
<FONT color="green">061</FONT>       * @return The XML String providing an index of all relevent sensor data resources.<a name="line.61"></a>
<FONT color="green">062</FONT>       */<a name="line.62"></a>
<FONT color="green">063</FONT>      public abstract String getSensorDataIndex(User user, String sdtName);<a name="line.63"></a>
<FONT color="green">064</FONT>      <a name="line.64"></a>
<FONT color="green">065</FONT>      /**<a name="line.65"></a>
<FONT color="green">066</FONT>       * Returns an XML SensorDataIndex representing the SensorData for the given user between<a name="line.66"></a>
<FONT color="green">067</FONT>       * start and end time whose resource string matches at least one of the UriPatterns.<a name="line.67"></a>
<FONT color="green">068</FONT>       * @param users The list of users whose SensorData will be returned.<a name="line.68"></a>
<FONT color="green">069</FONT>       * @param startTime The earliest Sensor Data to be returned.<a name="line.69"></a>
<FONT color="green">070</FONT>       * @param endTime The latest SensorData to be returned.<a name="line.70"></a>
<FONT color="green">071</FONT>       * @param uriPatterns At least one UriPattern must match the SensorData resource field.<a name="line.71"></a>
<FONT color="green">072</FONT>       * @param sdt The SDT of interest, or null if data from all SDTs should be retrieved.<a name="line.72"></a>
<FONT color="green">073</FONT>       * @return An XML String containing a SensorDataIndex of matching SensorData. <a name="line.73"></a>
<FONT color="green">074</FONT>       */<a name="line.74"></a>
<FONT color="green">075</FONT>      public abstract String getSensorDataIndex(List&lt;User&gt; users, XMLGregorianCalendar startTime, <a name="line.75"></a>
<FONT color="green">076</FONT>          XMLGregorianCalendar endTime, List&lt;String&gt; uriPatterns, String sdt);<a name="line.76"></a>
<FONT color="green">077</FONT>      <a name="line.77"></a>
<FONT color="green">078</FONT>      /**<a name="line.78"></a>
<FONT color="green">079</FONT>       * Returns an XML SensorDataIndex representing the SensorData for the given user between<a name="line.79"></a>
<FONT color="green">080</FONT>       * start and end time whose resource string matches at least one of the UriPatterns.<a name="line.80"></a>
<FONT color="green">081</FONT>       * @param users The list of users whose SensorData will be returned.<a name="line.81"></a>
<FONT color="green">082</FONT>       * @param startTime The earliest Sensor Data to be returned.<a name="line.82"></a>
<FONT color="green">083</FONT>       * @param endTime The latest SensorData to be returned.<a name="line.83"></a>
<FONT color="green">084</FONT>       * @param uriPatterns At least one UriPattern must match the SensorData resource field.<a name="line.84"></a>
<FONT color="green">085</FONT>       * @param sdt The SDT of interest. Should not be null.<a name="line.85"></a>
<FONT color="green">086</FONT>       * @param tool The tool of interest. Should not be null.<a name="line.86"></a>
<FONT color="green">087</FONT>       * @return An XML String containing a SensorDataIndex of matching SensorData. <a name="line.87"></a>
<FONT color="green">088</FONT>       */<a name="line.88"></a>
<FONT color="green">089</FONT>      public abstract String getSensorDataIndex(List&lt;User&gt; users, XMLGregorianCalendar startTime, <a name="line.89"></a>
<FONT color="green">090</FONT>          XMLGregorianCalendar endTime, List&lt;String&gt; uriPatterns, String sdt, String tool);<a name="line.90"></a>
<FONT color="green">091</FONT>    <a name="line.91"></a>
<FONT color="green">092</FONT>      <a name="line.92"></a>
<FONT color="green">093</FONT>      /**<a name="line.93"></a>
<FONT color="green">094</FONT>       * Returns the XML SensorDataIndex for all sensor data matching these users, start/end time, and <a name="line.94"></a>
<FONT color="green">095</FONT>       * whose resource string matches at least one in the list of UriPatterns. <a name="line.95"></a>
<FONT color="green">096</FONT>       * Client must guarantee that startTime and endTime are within Project dates, and that <a name="line.96"></a>
<FONT color="green">097</FONT>       * startIndex and maxInstances are non-negative.<a name="line.97"></a>
<FONT color="green">098</FONT>       * @param users The users. <a name="line.98"></a>
<FONT color="green">099</FONT>       * @param startTime The start time. <a name="line.99"></a>
<FONT color="green">100</FONT>       * @param endTime The end time. <a name="line.100"></a>
<FONT color="green">101</FONT>       * @param uriPatterns A list of UriPatterns. <a name="line.101"></a>
<FONT color="green">102</FONT>       * @param startIndex The starting index.<a name="line.102"></a>
<FONT color="green">103</FONT>       * @param maxInstances The maximum number of instances to return.<a name="line.103"></a>
<FONT color="green">104</FONT>       * @return The XML SensorDataIndex string corresponding to the matching sensor data. <a name="line.104"></a>
<FONT color="green">105</FONT>       */<a name="line.105"></a>
<FONT color="green">106</FONT>      public abstract String getSensorDataIndex(List&lt;User&gt; users, XMLGregorianCalendar startTime, <a name="line.106"></a>
<FONT color="green">107</FONT>          XMLGregorianCalendar endTime, List&lt;String&gt; uriPatterns, int startIndex, int maxInstances);<a name="line.107"></a>
<FONT color="green">108</FONT>    <a name="line.108"></a>
<FONT color="green">109</FONT>      <a name="line.109"></a>
<FONT color="green">110</FONT>      /**<a name="line.110"></a>
<FONT color="green">111</FONT>       * Returns the XML SensorDataIndex for all sensor data for the given user that arrived<a name="line.111"></a>
<FONT color="green">112</FONT>       * at the server since the given start and end timestamps.  <a name="line.112"></a>
<FONT color="green">113</FONT>       * This method uses the LastMod timestamp<a name="line.113"></a>
<FONT color="green">114</FONT>       * rather than the "regular" timestamp, and is used for real-time monitoring of data<a name="line.114"></a>
<FONT color="green">115</FONT>       * arriving at the server. <a name="line.115"></a>
<FONT color="green">116</FONT>       * @param user The user whose data is being monitored.<a name="line.116"></a>
<FONT color="green">117</FONT>       * @param lastModStartTime  The beginning lastMod timestamp of interest. <a name="line.117"></a>
<FONT color="green">118</FONT>       * @param lastModEndTime  The ending lastMod timestamp of interest. <a name="line.118"></a>
<FONT color="green">119</FONT>       * @return The XML SensorDataIndex for the recently arrived data based upon the lastMod tstamps.<a name="line.119"></a>
<FONT color="green">120</FONT>       */<a name="line.120"></a>
<FONT color="green">121</FONT>      public abstract String getSensorDataIndexLastMod(User user, XMLGregorianCalendar lastModStartTime,<a name="line.121"></a>
<FONT color="green">122</FONT>          XMLGregorianCalendar lastModEndTime);<a name="line.122"></a>
<FONT color="green">123</FONT>      <a name="line.123"></a>
<FONT color="green">124</FONT>    <a name="line.124"></a>
<FONT color="green">125</FONT>      /**<a name="line.125"></a>
<FONT color="green">126</FONT>       * Returns an XML SensorDataIndex to sensor data for the given time interval and sdt with<a name="line.126"></a>
<FONT color="green">127</FONT>       * the most recent runtime value.  This constitutes the "snapshot" of the data with the given<a name="line.127"></a>
<FONT color="green">128</FONT>       * sdt. If the tool parameter is null, then the last runtime snapshot is returned without regard<a name="line.128"></a>
<FONT color="green">129</FONT>       * to the tool.<a name="line.129"></a>
<FONT color="green">130</FONT>       * @param users The list of users whose sensor data will be checked.<a name="line.130"></a>
<FONT color="green">131</FONT>       * @param startTime The start time.<a name="line.131"></a>
<FONT color="green">132</FONT>       * @param endTime The end time. <a name="line.132"></a>
<FONT color="green">133</FONT>       * @param uriPatterns The uripatterns that must match the resource string. <a name="line.133"></a>
<FONT color="green">134</FONT>       * @param sdt The sensor data type of interest.<a name="line.134"></a>
<FONT color="green">135</FONT>       * @param tool The tool of interest, or null if any tool is OK.<a name="line.135"></a>
<FONT color="green">136</FONT>       * @return A string containing the XML representation of the SensorDataIndex for this snapshot.<a name="line.136"></a>
<FONT color="green">137</FONT>       */<a name="line.137"></a>
<FONT color="green">138</FONT>      public abstract String getProjectSensorDataSnapshot(List&lt;User&gt; users, XMLGregorianCalendar <a name="line.138"></a>
<FONT color="green">139</FONT>          startTime, XMLGregorianCalendar endTime, List&lt;String&gt; uriPatterns, String sdt, String tool);<a name="line.139"></a>
<FONT color="green">140</FONT>      <a name="line.140"></a>
<FONT color="green">141</FONT>      /**<a name="line.141"></a>
<FONT color="green">142</FONT>       * Returns the SensorData instance as XML string, or null if not found.<a name="line.142"></a>
<FONT color="green">143</FONT>       * @param user The user.<a name="line.143"></a>
<FONT color="green">144</FONT>       * @param timestamp The timestamp associated with this sensor data.<a name="line.144"></a>
<FONT color="green">145</FONT>       * @return The SensorData XML string, or null.<a name="line.145"></a>
<FONT color="green">146</FONT>       */<a name="line.146"></a>
<FONT color="green">147</FONT>      public abstract String getSensorData(User user, XMLGregorianCalendar timestamp);<a name="line.147"></a>
<FONT color="green">148</FONT>      <a name="line.148"></a>
<FONT color="green">149</FONT>      /**<a name="line.149"></a>
<FONT color="green">150</FONT>       * Returns true if the passed [key, timestamp] has sensor data defined for it.<a name="line.150"></a>
<FONT color="green">151</FONT>       * @param user The user.<a name="line.151"></a>
<FONT color="green">152</FONT>       * @param timestamp The timestamp<a name="line.152"></a>
<FONT color="green">153</FONT>       * @return True if there is any sensor data for this [key, sdtName, timestamp].<a name="line.153"></a>
<FONT color="green">154</FONT>       */<a name="line.154"></a>
<FONT color="green">155</FONT>      public abstract boolean hasSensorData(User user, XMLGregorianCalendar timestamp);<a name="line.155"></a>
<FONT color="green">156</FONT>      <a name="line.156"></a>
<FONT color="green">157</FONT>      /**<a name="line.157"></a>
<FONT color="green">158</FONT>       * Persists a SensorData instance.  If SensorData with this [email, timestamp] <a name="line.158"></a>
<FONT color="green">159</FONT>       * already exists in the storage system, it should be overwritten.<a name="line.159"></a>
<FONT color="green">160</FONT>       * @param data The sensor data. <a name="line.160"></a>
<FONT color="green">161</FONT>       * @param xmlSensorData The SensorData marshalled into an XML String.  <a name="line.161"></a>
<FONT color="green">162</FONT>       * @param xmlSensorDataRef The corresponding SensorDataRef marshalled into an XML String<a name="line.162"></a>
<FONT color="green">163</FONT>       * @return True if the sensor data was successfully inserted.<a name="line.163"></a>
<FONT color="green">164</FONT>       */<a name="line.164"></a>
<FONT color="green">165</FONT>      public abstract boolean storeSensorData(SensorData data, String xmlSensorData, <a name="line.165"></a>
<FONT color="green">166</FONT>          String xmlSensorDataRef);<a name="line.166"></a>
<FONT color="green">167</FONT>      <a name="line.167"></a>
<FONT color="green">168</FONT>    <a name="line.168"></a>
<FONT color="green">169</FONT>      /**<a name="line.169"></a>
<FONT color="green">170</FONT>       * Ensures that sensor data with the given user and timestamp is no longer<a name="line.170"></a>
<FONT color="green">171</FONT>       * present in this manager.<a name="line.171"></a>
<FONT color="green">172</FONT>       * @param user The user.<a name="line.172"></a>
<FONT color="green">173</FONT>       * @param timestamp The timestamp associated with this sensor data.<a name="line.173"></a>
<FONT color="green">174</FONT>       */<a name="line.174"></a>
<FONT color="green">175</FONT>      public abstract void deleteSensorData(User user, XMLGregorianCalendar timestamp);<a name="line.175"></a>
<FONT color="green">176</FONT>      <a name="line.176"></a>
<FONT color="green">177</FONT>      /**<a name="line.177"></a>
<FONT color="green">178</FONT>       * Ensures that sensor data with the given user is no longer present in this manager.<a name="line.178"></a>
<FONT color="green">179</FONT>       * @param user The user.<a name="line.179"></a>
<FONT color="green">180</FONT>       */<a name="line.180"></a>
<FONT color="green">181</FONT>      public abstract void deleteSensorData(User user);<a name="line.181"></a>
<FONT color="green">182</FONT>      <a name="line.182"></a>
<FONT color="green">183</FONT>      /**<a name="line.183"></a>
<FONT color="green">184</FONT>       * Returns the XML SensorDataTypeIndex for all SDTs in this server.<a name="line.184"></a>
<FONT color="green">185</FONT>       * @return The XML String containing an index to all SensorDataTypes.<a name="line.185"></a>
<FONT color="green">186</FONT>       */<a name="line.186"></a>
<FONT color="green">187</FONT>      public abstract String getSensorDataTypeIndex();<a name="line.187"></a>
<FONT color="green">188</FONT>      <a name="line.188"></a>
<FONT color="green">189</FONT>      /**<a name="line.189"></a>
<FONT color="green">190</FONT>       * Returns the SensorDataType instance as XML string, or null if not found.<a name="line.190"></a>
<FONT color="green">191</FONT>       * @param sdtName The SDT name.<a name="line.191"></a>
<FONT color="green">192</FONT>       * @return The SensorDataType XML string, or null.<a name="line.192"></a>
<FONT color="green">193</FONT>       */<a name="line.193"></a>
<FONT color="green">194</FONT>      public abstract String getSensorDataType(String sdtName);<a name="line.194"></a>
<FONT color="green">195</FONT>      <a name="line.195"></a>
<FONT color="green">196</FONT>      <a name="line.196"></a>
<FONT color="green">197</FONT>      /**<a name="line.197"></a>
<FONT color="green">198</FONT>       * Persists a SensorDataType instance.  If a SensorDataType with this name<a name="line.198"></a>
<FONT color="green">199</FONT>       * already exists in the storage system, it will be overwritten.<a name="line.199"></a>
<FONT color="green">200</FONT>       * @param sdt The sensor data type <a name="line.200"></a>
<FONT color="green">201</FONT>       * @param xmlSensorDataType The SensorDataType marshalled into an XML String.  <a name="line.201"></a>
<FONT color="green">202</FONT>       * @param xmlSensorDataTypeRef The corresponding SensorDataTypeRef marshalled into an XML String<a name="line.202"></a>
<FONT color="green">203</FONT>       * @return True if the SDT was successfully inserted.<a name="line.203"></a>
<FONT color="green">204</FONT>       */<a name="line.204"></a>
<FONT color="green">205</FONT>      public abstract boolean storeSensorDataType(SensorDataType sdt, String xmlSensorDataType, <a name="line.205"></a>
<FONT color="green">206</FONT>          String xmlSensorDataTypeRef);<a name="line.206"></a>
<FONT color="green">207</FONT>      <a name="line.207"></a>
<FONT color="green">208</FONT>      /**<a name="line.208"></a>
<FONT color="green">209</FONT>       * Ensures that the SensorDataType with the given name is no longer present in this manager.<a name="line.209"></a>
<FONT color="green">210</FONT>       * @param sdtName The SDT name.<a name="line.210"></a>
<FONT color="green">211</FONT>       */<a name="line.211"></a>
<FONT color="green">212</FONT>      public abstract void deleteSensorDataType(String sdtName);<a name="line.212"></a>
<FONT color="green">213</FONT>      <a name="line.213"></a>
<FONT color="green">214</FONT>      /**<a name="line.214"></a>
<FONT color="green">215</FONT>       * Returns the XML UserIndex for all Users in this server.<a name="line.215"></a>
<FONT color="green">216</FONT>       * @return The XML String containing an index to all Users.<a name="line.216"></a>
<FONT color="green">217</FONT>       */<a name="line.217"></a>
<FONT color="green">218</FONT>      public abstract String getUserIndex();<a name="line.218"></a>
<FONT color="green">219</FONT>      <a name="line.219"></a>
<FONT color="green">220</FONT>      /**<a name="line.220"></a>
<FONT color="green">221</FONT>       * Returns the User instance as XML string, or null if not found.<a name="line.221"></a>
<FONT color="green">222</FONT>       * @param email The user's email.<a name="line.222"></a>
<FONT color="green">223</FONT>       * @return The User XML string, or null.<a name="line.223"></a>
<FONT color="green">224</FONT>       */<a name="line.224"></a>
<FONT color="green">225</FONT>      public abstract String getUser(String email);<a name="line.225"></a>
<FONT color="green">226</FONT>      <a name="line.226"></a>
<FONT color="green">227</FONT>      /**<a name="line.227"></a>
<FONT color="green">228</FONT>       * Persists a User instance.  If a User with this name<a name="line.228"></a>
<FONT color="green">229</FONT>       * already exists in the storage system, it will be overwritten.<a name="line.229"></a>
<FONT color="green">230</FONT>       * @param user The user<a name="line.230"></a>
<FONT color="green">231</FONT>       * @param xmlUser The User marshalled into an XML String.  <a name="line.231"></a>
<FONT color="green">232</FONT>       * @param xmlUserRef The corresponding UserRef marshalled into an XML String<a name="line.232"></a>
<FONT color="green">233</FONT>       * @return True if the user was successfully inserted.<a name="line.233"></a>
<FONT color="green">234</FONT>       */<a name="line.234"></a>
<FONT color="green">235</FONT>      public abstract boolean storeUser(User user, String xmlUser, String xmlUserRef);<a name="line.235"></a>
<FONT color="green">236</FONT>      <a name="line.236"></a>
<FONT color="green">237</FONT>      /**<a name="line.237"></a>
<FONT color="green">238</FONT>       * Ensures that the User with the given email is no longer present in this manager.<a name="line.238"></a>
<FONT color="green">239</FONT>       * @param email The user's email address.<a name="line.239"></a>
<FONT color="green">240</FONT>       */<a name="line.240"></a>
<FONT color="green">241</FONT>      public abstract void deleteUser(String email);<a name="line.241"></a>
<FONT color="green">242</FONT>      <a name="line.242"></a>
<FONT color="green">243</FONT>      /**<a name="line.243"></a>
<FONT color="green">244</FONT>       * Returns the XML ProjectIndex for all Projects in this server.<a name="line.244"></a>
<FONT color="green">245</FONT>       * @return The XML String containing an index to all Projects.<a name="line.245"></a>
<FONT color="green">246</FONT>       */<a name="line.246"></a>
<FONT color="green">247</FONT>      public abstract String getProjectIndex();<a name="line.247"></a>
<FONT color="green">248</FONT>      <a name="line.248"></a>
<FONT color="green">249</FONT>      /**<a name="line.249"></a>
<FONT color="green">250</FONT>       * Returns the Project instance as XML string, or null if not found.<a name="line.250"></a>
<FONT color="green">251</FONT>       * @param owner The user who owns the project.<a name="line.251"></a>
<FONT color="green">252</FONT>       * @param projectName The name of the Project.<a name="line.252"></a>
<FONT color="green">253</FONT>       * @return The Project XML string, or null.<a name="line.253"></a>
<FONT color="green">254</FONT>       */<a name="line.254"></a>
<FONT color="green">255</FONT>      public abstract String getProject(User owner, String projectName);<a name="line.255"></a>
<FONT color="green">256</FONT>      <a name="line.256"></a>
<FONT color="green">257</FONT>      /**<a name="line.257"></a>
<FONT color="green">258</FONT>       * Persists a Project instance.  If a Project with this owner and name<a name="line.258"></a>
<FONT color="green">259</FONT>       * already exists in the storage system, it will be overwritten.<a name="line.259"></a>
<FONT color="green">260</FONT>       * @param project The Project.<a name="line.260"></a>
<FONT color="green">261</FONT>       * @param xmlProject The Project marshalled into an XML String.  <a name="line.261"></a>
<FONT color="green">262</FONT>       * @param xmlProjectRef The corresponding ProjectRef marshalled into an XML String<a name="line.262"></a>
<FONT color="green">263</FONT>       * @return True if the user was successfully inserted.<a name="line.263"></a>
<FONT color="green">264</FONT>       */<a name="line.264"></a>
<FONT color="green">265</FONT>      public abstract boolean storeProject(Project project, String xmlProject, String xmlProjectRef);<a name="line.265"></a>
<FONT color="green">266</FONT>      <a name="line.266"></a>
<FONT color="green">267</FONT>      /**<a name="line.267"></a>
<FONT color="green">268</FONT>       * Ensures that the Project with the given owner and projectName is no longer present in the db.<a name="line.268"></a>
<FONT color="green">269</FONT>       * @param owner The User who owns this project.<a name="line.269"></a>
<FONT color="green">270</FONT>       * @param projectName The name of the Project.<a name="line.270"></a>
<FONT color="green">271</FONT>       */<a name="line.271"></a>
<FONT color="green">272</FONT>      public abstract void deleteProject(User owner, String projectName);<a name="line.272"></a>
<FONT color="green">273</FONT>      <a name="line.273"></a>
<FONT color="green">274</FONT>      /**<a name="line.274"></a>
<FONT color="green">275</FONT>       * Returns a ProjectSummary instance constructed for the given Project between the startTime<a name="line.275"></a>
<FONT color="green">276</FONT>       * and endTime. This summary provides a breakdown of the number of sensor data instances found<a name="line.276"></a>
<FONT color="green">277</FONT>       * of the given type during the given time period.<a name="line.277"></a>
<FONT color="green">278</FONT>       * @param users The users in this project.<a name="line.278"></a>
<FONT color="green">279</FONT>       * @param startTime The startTime<a name="line.279"></a>
<FONT color="green">280</FONT>       * @param endTime The endTime.<a name="line.280"></a>
<FONT color="green">281</FONT>       * @param uriPatterns The UriPatterns for this project.<a name="line.281"></a>
<FONT color="green">282</FONT>       * @param href The URL naming this resource. <a name="line.282"></a>
<FONT color="green">283</FONT>       * @return The ProjectSummary instance. <a name="line.283"></a>
<FONT color="green">284</FONT>       */<a name="line.284"></a>
<FONT color="green">285</FONT>      public abstract ProjectSummary getProjectSummary(List&lt;User&gt; users, XMLGregorianCalendar startTime,<a name="line.285"></a>
<FONT color="green">286</FONT>          XMLGregorianCalendar endTime, List&lt;String&gt; uriPatterns, String href);<a name="line.286"></a>
<FONT color="green">287</FONT>    <a name="line.287"></a>
<FONT color="green">288</FONT>      <a name="line.288"></a>
<FONT color="green">289</FONT>      /** Keeps a pointer to this Server for use in accessing the managers. */<a name="line.289"></a>
<FONT color="green">290</FONT>      protected Server server;<a name="line.290"></a>
<FONT color="green">291</FONT>      <a name="line.291"></a>
<FONT color="green">292</FONT>      /** Keep a pointer to the Logger. */<a name="line.292"></a>
<FONT color="green">293</FONT>      protected Logger logger;<a name="line.293"></a>
<FONT color="green">294</FONT>      <a name="line.294"></a>
<FONT color="green">295</FONT>      /**<a name="line.295"></a>
<FONT color="green">296</FONT>       * Constructs a new DbImplementation.<a name="line.296"></a>
<FONT color="green">297</FONT>       * @param server The server. <a name="line.297"></a>
<FONT color="green">298</FONT>       */<a name="line.298"></a>
<FONT color="green">299</FONT>      public DbImplementation(Server server) {<a name="line.299"></a>
<FONT color="green">300</FONT>        this.server = server;<a name="line.300"></a>
<FONT color="green">301</FONT>        this.logger = server.getLogger();<a name="line.301"></a>
<FONT color="green">302</FONT>      }<a name="line.302"></a>
<FONT color="green">303</FONT>      <a name="line.303"></a>
<FONT color="green">304</FONT>      /**<a name="line.304"></a>
<FONT color="green">305</FONT>       * Returns the UserManager associated with this server.<a name="line.305"></a>
<FONT color="green">306</FONT>       * Since the DbManager is initialized before all other managers, we will simply <a name="line.306"></a>
<FONT color="green">307</FONT>       * get these other Managers on demand and not cache them. <a name="line.307"></a>
<FONT color="green">308</FONT>       * @return The User Manager. <a name="line.308"></a>
<FONT color="green">309</FONT>       */<a name="line.309"></a>
<FONT color="green">310</FONT>      protected UserManager getUserManager() {<a name="line.310"></a>
<FONT color="green">311</FONT>        return (UserManager)server.getContext().getAttributes().get("UserManager");<a name="line.311"></a>
<FONT color="green">312</FONT>      }<a name="line.312"></a>
<FONT color="green">313</FONT>      <a name="line.313"></a>
<FONT color="green">314</FONT>      /**<a name="line.314"></a>
<FONT color="green">315</FONT>       * Returns the SensorDataManager associated with this server. <a name="line.315"></a>
<FONT color="green">316</FONT>       * Since the DbManager is initialized before all other managers, we will simply <a name="line.316"></a>
<FONT color="green">317</FONT>       * get these other Managers on demand and not cache them. <a name="line.317"></a>
<FONT color="green">318</FONT>       * @return The Sensor Data Manager. <a name="line.318"></a>
<FONT color="green">319</FONT>       */<a name="line.319"></a>
<FONT color="green">320</FONT>      protected SensorDataManager getSensorDataManager() {<a name="line.320"></a>
<FONT color="green">321</FONT>        return (SensorDataManager)server.getContext().getAttributes().get("SensorDataManager");<a name="line.321"></a>
<FONT color="green">322</FONT>      }<a name="line.322"></a>
<FONT color="green">323</FONT>      <a name="line.323"></a>
<FONT color="green">324</FONT>      /**<a name="line.324"></a>
<FONT color="green">325</FONT>       * Returns the SdtManager associated with this server. <a name="line.325"></a>
<FONT color="green">326</FONT>       * Since the DbManager is initialized before all other managers, we will simply <a name="line.326"></a>
<FONT color="green">327</FONT>       * get these other Managers on demand and not cache them. <a name="line.327"></a>
<FONT color="green">328</FONT>       * @return The SdtManager. <a name="line.328"></a>
<FONT color="green">329</FONT>       */<a name="line.329"></a>
<FONT color="green">330</FONT>      protected SdtManager getSdtManager() {<a name="line.330"></a>
<FONT color="green">331</FONT>        return (SdtManager)server.getContext().getAttributes().get("SdtManager");<a name="line.331"></a>
<FONT color="green">332</FONT>      }<a name="line.332"></a>
<FONT color="green">333</FONT>      <a name="line.333"></a>
<FONT color="green">334</FONT>      /**<a name="line.334"></a>
<FONT color="green">335</FONT>       * Returns the ProjectManager associated with this server. <a name="line.335"></a>
<FONT color="green">336</FONT>       * Since the DbManager is initialized before all other managers, we will simply <a name="line.336"></a>
<FONT color="green">337</FONT>       * get these other Managers on demand and not cache them. <a name="line.337"></a>
<FONT color="green">338</FONT>       * @return The ProjectManager. <a name="line.338"></a>
<FONT color="green">339</FONT>       */<a name="line.339"></a>
<FONT color="green">340</FONT>      protected ProjectManager getProjectManager() {<a name="line.340"></a>
<FONT color="green">341</FONT>        return (ProjectManager)server.getContext().getAttributes().get("ProjectManager");<a name="line.341"></a>
<FONT color="green">342</FONT>      }<a name="line.342"></a>
<FONT color="green">343</FONT>      <a name="line.343"></a>
<FONT color="green">344</FONT>      <a name="line.344"></a>
<FONT color="green">345</FONT>      /**<a name="line.345"></a>
<FONT color="green">346</FONT>       * Databases like Derby require an explicit compress command for releasing disk space <a name="line.346"></a>
<FONT color="green">347</FONT>       * after a large number of rows have been deleted.  This operation invokes the compress<a name="line.347"></a>
<FONT color="green">348</FONT>       * command on all tables in the database.  If a database implementation does not support<a name="line.348"></a>
<FONT color="green">349</FONT>       * explicit compression, then this command should do nothing but return true.   <a name="line.349"></a>
<FONT color="green">350</FONT>       * @return True if the compress command succeeded or if the database does not support<a name="line.350"></a>
<FONT color="green">351</FONT>       * compression. <a name="line.351"></a>
<FONT color="green">352</FONT>       */<a name="line.352"></a>
<FONT color="green">353</FONT>      public abstract boolean compressTables();<a name="line.353"></a>
<FONT color="green">354</FONT>      <a name="line.354"></a>
<FONT color="green">355</FONT>      /**<a name="line.355"></a>
<FONT color="green">356</FONT>       * The most appropriate set of indexes for the database has been evolving over time as we <a name="line.356"></a>
<FONT color="green">357</FONT>       * develop new queries.  This command sets up the appropriate set of indexes.  It should be<a name="line.357"></a>
<FONT color="green">358</FONT>       * able to be called repeatedly without error. <a name="line.358"></a>
<FONT color="green">359</FONT>       * @return True if the index commands succeeded. <a name="line.359"></a>
<FONT color="green">360</FONT>       */<a name="line.360"></a>
<FONT color="green">361</FONT>      public abstract boolean indexTables(); <a name="line.361"></a>
<FONT color="green">362</FONT>      <a name="line.362"></a>
<FONT color="green">363</FONT>      /**<a name="line.363"></a>
<FONT color="green">364</FONT>       * Returns the current number of rows in the specified table.  <a name="line.364"></a>
<FONT color="green">365</FONT>       * @param table The table whose rows are to be counted. <a name="line.365"></a>
<FONT color="green">366</FONT>       * @return The number of rows in the table, or -1 if the table does not exist or an error occurs. <a name="line.366"></a>
<FONT color="green">367</FONT>       */<a name="line.367"></a>
<FONT color="green">368</FONT>      public abstract int getRowCount(String table); <a name="line.368"></a>
<FONT color="green">369</FONT>      <a name="line.369"></a>
<FONT color="green">370</FONT>      /**<a name="line.370"></a>
<FONT color="green">371</FONT>       * Returns a set containing the names of all tables in this database.  Used by clients to <a name="line.371"></a>
<FONT color="green">372</FONT>       * invoke getRowCount with a legal table name. <a name="line.372"></a>
<FONT color="green">373</FONT>       * @return A set of table names.<a name="line.373"></a>
<FONT color="green">374</FONT>       */<a name="line.374"></a>
<FONT color="green">375</FONT>      public abstract Set&lt;String&gt; getTableNames(); <a name="line.375"></a>
<FONT color="green">376</FONT>      <a name="line.376"></a>
<FONT color="green">377</FONT>    }<a name="line.377"></a>




























































</PRE>
</BODY>
</HTML>
